Skip to main content

POST Original File

Overview


The table below provides details on the POST method used to manage access control for an original file.

POST Original File
MethodPOST
URL or Endpoint/api/v1/projectId/audios/audioId/original-files
HeadersAuthorization
ParametersaudioId, projectId
Request BodyaccessControl

The description of the URL parameter is as follows:

URL Parameter NameMandatoryTypeDescription
projectIdYesstringUnique Id of the project.
audioIdYesstringUnique id of the audio.

Request Body

{
"accessControl": 1
}

Information about the fields that appear when you type in the request body are displayed in the table below.

Parameter NameMandatoryTypeDescription
accessControlYesintegerAccess control level
## Response
{
"success": true,
"errors": [],
"messages": [],
"result": {
"accessControl": 1
},
"resultInfo": "{resultInfo}",
"statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Top-Level Properties

Field NameTypeDescription
successbooleanIf the response is successful it will return true. Otherwise will return false
errorsarray[string]Indicates if there was an error
messagesarray[string]Returns the response message from back-end
resultobjectReturns the response object
accessControlintegerAccess control level
resultInfostringReturns extra information about the result
statusCodeintegerReturns the HTTP Status Code

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed